International Validation

1.0.x
(0 reviews)

API Usage

Resource Information:

Endpoint NameFunctionResource URLVerb
validate-stop-wordThis response indicates that the request was processed successfully, but not all parcel content descriptions passed validation for example, “shoes” was rejected as too generic and requires a more specific description.UAT:
https://api.uat.nzpost.co.nz/international-validation/v1/ead/validate-stop-word
PROD:
https://api.nzpost.co.nz/international-validation/v1/ead/validate-stop-word		POST

Sample Request

{
    "destination_country_code": "FR",
    "descriptions": ["Fancy tshirt", "small jewellery toy", "shoes"]
}

Sample Response

{
    "success": true,
    "country_has_validation": true,
    "results": [
        {
            "description": "Fancy tshirt",
            "is_valid": true
        },
        {
            "description": "small jewellery toy",
            "is_valid": true
        },
        {
            "description": "shoes",
            "is_valid": false,
            "reason": "The content description: shoes is not acceptable for customs declaration. Please provide a more specific description."
        }
    ],
    "all_valid": false,
    "message_id": "5e93f140-7ca4-11f0-8408-06fad0e85b65"
}

Reviews